-
Notifications
You must be signed in to change notification settings - Fork 18
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chores: bump deps and update swagger #84
Conversation
WalkthroughThis pull request updates the project’s Go environment across multiple configurations. It replaces Go version 1.22 with 1.23 (and corresponding minor revisions) in GitHub workflow files, Dockerfiles, and the go.mod file. Additionally, import paths for internal packages have been streamlined, and initialization logic in the block SDK has been adjusted with parameter updates. API documentation in swagger.yaml and version constants in the upgrade module are also revised. Changes
Sequence Diagram(s)sequenceDiagram
participant App as MinitiaApp
participant SDK as setupBlockSDK
participant CheckTx as blockchecktx.NewMempoolParityCheckTx
participant PropHandler as blockabci.New
App->>SDK: Initialize BlockSDK
SDK->>CheckTx: Setup check transaction handler (with app.BaseApp)
SDK->>PropHandler: Initialize proposal handler (with extra boolean flag)
SDK-->>App: Return configured handlers
Possibly related PRs
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (1)
🔇 Additional comments (18)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🧹 Nitpick comments (9)
client/docs/swagger-ui/swagger.yaml (9)
22794-22806
: Update for QueryChannelClientStateResponse (Part 1):
The additional lines explain the JSON tag override in detail. While the redundancy across different endpoints might be streamlined in the future, the current change is clear and precise.
24096-24108
: Typographical Note for QueryPacketAcknowledgemetsResponse:
The updated description is detailed; however, note that “Acknowledgemets” appears to be a typo. Please consider correcting it to “Acknowledgements.”
25623-25635
: Enhanced Details for QueryPacketCommitmentResponse:
The update mirrors other similar sections, ensuring that the behavior is documented uniformly. In the future, consider abstracting common text for reduced redundancy.
38409-38417
: New Property ‘hook_max_gas’ Added:
The addition of the “hook_max_gas” property—with its type, format, and title—is clearly specified. Consider reviewing naming conventions for consistency with other similar fields.
39717-39723
: UpgradePolicy Enumeration Repetition (Part 2):
This block repeats similar UpgradePolicy details. Consider consolidating such repeated text into a shared schema component.
44098-44161
: New Oracle Endpoint for Currency Pair Mapping List:
The endpoint “/connect/oracle/v2/get_currency_pair_mapping_list” is added with detailed nested schema definitions. Ensure that the nested properties (id and currency_pair) accurately reflect the data model.
44769-44935
: Markets Endpoint Enhancement:
The revised schema for “/connect/marketmap/v2/markets” is extensive and detailed. The nested definitions for ticker and provider_configs are well documented. Consider refactoring overly verbose nested descriptions if they are repeated elsewhere.
64552-64564
: QueryPacketAcknowledgementResponse Naming Note:
The updated block is clear; however, please ensure that the naming (singular vs. plural “Acknowledgement”) remains consistent throughout the API documentation.
70657-70663
: UpgradePolicy Text Repetition (Part 1):
The UpgradePolicy descriptions are repeated here. Consider consolidating repeated text to reduce maintenance overhead in the future.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
go.sum
is excluded by!**/*.sum
📒 Files selected for processing (15)
.github/workflows/build-darwin-amd64.yml
(1 hunks).github/workflows/build-darwin-arm64.yml
(1 hunks).github/workflows/build-linux-amd64.yml
(1 hunks).github/workflows/test.yml
(1 hunks)Dockerfile
(1 hunks)Dockerfile.arm64
(1 hunks)README.md
(1 hunks)app/blocksdk.go
(1 hunks)app/keepers/keepers.go
(2 hunks)app/keepers/keys.go
(1 hunks)app/modules.go
(1 hunks)app/upgrade.go
(1 hunks)client/docs/swagger-ui/swagger.yaml
(90 hunks)go.mod
(10 hunks)shared.Dockerfile
(1 hunks)
✅ Files skipped from review due to trivial changes (2)
- app/modules.go
- app/upgrade.go
🔇 Additional comments (108)
app/keepers/keys.go (1)
44-44
: LGTM!The import path has been simplified while maintaining the same functionality.
app/blocksdk.go (2)
124-129
: LGTM!The
NewMempoolParityCheckTx
initialization has been updated to include theBaseApp
parameter, aligning with the latest block-sdk dependency.
132-138
: LGTM!The proposal handler initialization has been updated to use
blockabci.New
with an additional boolean parameter, aligning with the latest block-sdk dependency.app/keepers/keepers.go (2)
88-90
: LGTM!The import paths have been simplified while maintaining the same functionality.
306-306
: LGTM!The method has been renamed from
WithPostUpdateHandler
toSetPostUpdateHandler
to align with the latest ibc-go dependency.client/docs/swagger-ui/swagger.yaml (80)
21938-21950
: RevisionHeight Documentation Enhancement (QueryChannelsResponse):
The added detailed description regarding the “RevisionHeight” reset and the explicit JSON tag override is clear and consistent. Consider standardizing the capitalization (e.g. “Gets reset”) for uniformity across the documentation.
22332-22344
: Enhanced Description for QueryChannelResponse:
The documentation now clearly explains that the “RevisionHeight” gets reset and that the JSON marshaller will always emit zero values. This mirrors the change in the previous block and is consistent.
23236-23248
: Update for QueryChannelClientStateResponse (Part 2):
This hunk mirrors the earlier changes in similar endpoints, ensuring that the “RevisionHeight” behavior is consistently documented.
23514-23526
: Documentation Update for QuerySequenceResponse:
The added explanation about “RevisionHeight” reset and the JSON tagging is properly integrated into the description for the QuerySequenceResponse.
23778-23790
: Update for QueryNextSequenceSendResponse:
The revised description detailing the JSON marshaller behavior is consistent with earlier updates.
24425-24437
: Clarification in QueryPacketAcknowledgementResponse:
The documentation now clearly explains that the Go JSON marshaller will always emit zero values, which aligns with the style introduced in previous endpoints.
24751-24763
: Update for QueryPacketCommitmentsResponse:
The detailed notes regarding the JSON tag behavior have been added consistently. No issues are noted.
25073-25085
: Revision for QueryUnreceivedAcksResponse:
The documentation now consistently explains the JSON marshaller behavior in the context of revision height.
25349-25361
: Documentation Update for QueryUnreceivedPacketsResponse:
The added lines provide a consistent explanation regarding the JSON tags and “RevisionHeight” reset.
25901-25913
: Clear Documentation for QueryPacketReceiptResponse:
The updated details clearly state the behavior regarding JSON tag overrides for “revision_number” and “revision_height.”
26204-26218
: Timestamp Field Documentation Enhancement:
The nested documentation update, including the explanation for “RevisionHeight” reset, is well integrated.
26279-26291
: Update for QueryUpgradeResponse:
The documentation now includes the detailed JSON marshaller instructions. The added information is both clear and consistent with similar changes.
26555-26567
: UpgradeErrorResponse Documentation Update:
The additions to describe the JSON marshaller and “RevisionHeight” behavior are comprehensive and clear.
26934-26946
: Documenting QueryConnectionChannelsResponse:
The updated description is consistent with other endpoints. The formatting and content are clear.
27250-27264
: Timestamp Nesting Update in Consensus State:
The revision update now correctly documents the timestamp field and its relation to the resetting of “RevisionHeight.”
28187-28199
: QueryClientStateResponse Documentation Update:
The revised block now clearly details the behavior of “RevisionHeight” in the response—consistent with similar updates.
28669-28681
: Consensus_State Schema Enhancement:
The updates ensure that the JSON marshaller behavior is explicitly defined within the consensus state block.
29197-29209
: Height Definition Clarification:
The description now clearly explains that “Height” is a monotonically increasing data type. This is helpful for clients reading the API documentation.
29727-29739
: Consistent Update for Height Documentation:
The update continues to maintain the consistency of the definition of the “Height” field.
31223-31235
: Uniform Height Documentation:
This block reinforces the concept of monotonicity for “Height” and is consistent with earlier changes.
31319-31331
: QueryClientConnectionsResponse Enhancement:
The updated documentation now includes the new revision note regarding “RevisionHeight” and is clear in its intentions.
31686-31698
: QueryConnectionsResponse Documentation Improvement:
The revised description is uniform with the rest of the API and clearly outlines the behavior regarding JSON marshaller behavior.
32087-32099
: QueryConnectionResponse Update:
The update clearly specifies the JSON marshaller behavior and “RevisionHeight” reset for this endpoint.
32542-32554
: Clear Documentation for QueryConnectionClientStateResponse:
The response type now includes consistent details regarding the reset of “RevisionHeight.”
32979-32991
: QueryConnectionConsensusStateResponse Update:
The revised descriptions maintain consistency with previous updates. Ensure that client implementations are aware of the path change.
34042-34048
: Endpoint Path Change for NFT Transfer:
The endpoint path is now updated to “/ibc/apps/nft_transfer/v1/class_hashes/{trace}” (correcting “class_hashs”). Verify that this rename is synchronized in all client and server integrations.
37423-37429
: Update for Base Denom Endpoint in opinit:
The documentation for the “/opinit/opchild/v1/base_denom” endpoint is revised; ensure that the new endpoint behavior is consistent with updated implementation details.
37633-37640
: Parameter Change for ‘denom’ in opinit Endpoint:
The parameter “denom” is now defined as a query parameter and is optional. Ensure that API consumers update their requests accordingly.
37693-37702
: Enum Update for Target Chain Type:
The target chain type now includes the values UNSPECIFIED, INITIA, and CELESTIA with a default value. This is a useful addition that aligns with overall design.
37708-37714
: Addition of Finalization and Submission Properties:
The new properties “finalization_period” and “submission_start_height” are now part of the schema. Their descriptions appear complete and are consistent with other similar definitions.
39571-39577
: UpgradePolicy Enumeration Updated (Part 1):
The descriptions for the UpgradePolicy enum values (UNSPECIFIED, COMPATIBLE, IMMUTABLE) are now more detailed. Verify that these descriptions match the backend behavior.
40728-40734
: New Endpoint for ViewJSON:
The new endpoint “/initia/move/v1/view/json” with operationId “ViewJSON” is documented. Please ensure that the request/response definitions match the implementation.
40815-40821
: New Endpoint for ViewJSONBatch:
This endpoint is added to support batch operations. The summary and operationId are clear and the response section appears well structured.
44581-44588
: MarketMap Endpoint Update:
The summary for the MarketMap endpoint has been updated. The changes are clear; please verify that the service behavior corresponds with the documentation.
63443-63454
: Timestamp Schema Update:
The changes update the timestamp field with proper formatting and explanation. This is consistent with earlier changes.
63682-63694
: QueryChannelClientStateResponse Revision Update (Part 1):
The added details regarding the JSON tag overrides are clear and consistent with similar endpoints.
63895-63907
: QueryChannelClientStateResponse Revision Update (Part 2):
This block further reinforces the schema changes applied to QueryChannelClientStateResponse; everything appears consistent.
63944-63956
: Timestamp Field Consistency:
The update to the timestamp field is consistent with previous revisions and confirms the required formatting.
64087-64099
: QueryChannelResponse Documentation Update:
The description now clearly specifies the behavior of the JSON marshaller for “RevisionHeight” in this endpoint.
64248-64260
: QueryChannelsResponse Update:
The documentation is updated to uniformly include the detailed “RevisionHeight” behavior.
64405-64417
: QueryConnectionChannelsResponse Update:
The revised documentation effectively communicates the behavior regarding “RevisionHeight”.
64454-64466
: QuerySequenceResponse Documentation Update:
The changes mirror those in similar endpoints and provide clear, consistent information.
64503-64515
: QueryNextSequenceSendResponse Update:
The documentation has been updated with the revised schema details; everything is in order.
64698-64710
: QueryPacketCommitmentResponse Update:
The updates in this block maintain consistency with the rest of the documentation.
64798-64810
: QueryPacketCommitmentsResponse Enhancement:
The block is updated with consistent details regarding the JSON marshaller and revision behavior.
64846-64858
: QueryPacketReceiptResponse Documentation Update:
The detailed description and schema adjustments are clear and consistent with other endpoints.
64897-64909
: QueryUnreceivedAcksResponse Revision Update:
The changes clearly detail the expected behavior for the revision reset; the documentation is consistent.
64944-64956
: QueryUnreceivedPacketsResponse Documentation Update:
The updated details regarding “RevisionHeight” and JSON tag behavior are clearly conveyed.
65007-65019
: QueryUpgradeErrorResponse Revision Update:
The documentation has been updated with the same detailed pattern seen in similar endpoints.
65080-65092
: Timestamp Field Update for Revision Block:
The updated timestamp field is well documented and conforms to the new standards set in previous changes.
65150-65162
: QueryUpgradeResponse Revision Update:
The changes are clearly documented and consistent with the patterns established in earlier updates.
65215-65227
: Timestamp Property Consistency:
The revision block now includes an updated timestamp property; it is consistent with similar sections throughout the document.
65296-65308
: Timestamp Schema Revision:
The detailed explanation regarding the JSON tag overrides and timestamp format is clearly outlined.
65369-65393
: Height Description Revision:
The revised description emphasizes that “Height” is monotonically increasing while accounting for state resets. The explanation is clear and informative.
65600-65612
: Consensus State Block Update:
The update integrates the JSON marshaller details into the consensus state schema. This is consistent with the overall revision changes.
66018-66030
: QueryClientStateResponse Revision Reinforcement:
The schema update here is in line with similar changes and reinforces the expected behavior for “RevisionHeight.”
66299-66311
: Height Field Documentation Reiteration:
The description for “Height” is repeated here for clarity and consistency; it is well written.
66545-66557
: Additional Height Documentation:
The block reiterates that “Height” is a monotonically increasing value, consistent with previous updates.
66601-66613
: Consensus State Block (Additional) Update:
The JSON marshaller information and revision notes are consistently documented in this consensus_state section.
67198-67210
: Height Field Consistency Update:
The updated description reinforces the monotonicity of the “Height” field as expected after resets.
67526-67538
: QueryClientConnectionsResponse Revision Update:
The documentation here is updated consistently with other similar endpoints regarding revision behavior.
67752-67764
: QueryConnectionClientStateResponse Revision Update:
The changes maintain the same level of detail regarding “RevisionHeight” resets.
67965-67977
: QueryConnectionConsensusStateResponse Revision Update:
The documentation has been updated with the familiar pattern; everything appears consistent.
68122-68134
: QueryConnectionResponse Revision Update:
The detailed note regarding the JSON marshaller enhancement is clearly incorporated.
68277-68289
: QueryConnectionsResponse Revision Update:
The update continues the consistent documentation style seen throughout the file.
69577-69584
: Chain Type Enum Enhancement:
The enum for chain type now explicitly includes UNSPECIFIED, INITIA, and CELESTIA. This improvement is clear and useful.
69591-69597
: Finalization and Submission Properties Update:
The new schema properties “finalization_period” and “submission_start_height” are well documented and fit naturally into the parameter definitions.
69649-69658
: hook_max_gas Addition for QueryBaseDenomResponse:
The new property “hook_max_gas” is clearly added with appropriate type and format.
69710-69718
: Target Chain Type Enum in opinit Module:
The enum update for target chain type in this module is clearly documented.
69724-69730
: Finalization and Submission in opinit Module:
The update for “finalization_period” and “submission_start_height” is consistent with other similar sections.
69812-69820
: hook_max_gas for QueryValidatorResponse:
The property is added with clear documentation. Verify that the field’s naming and type are consistent with other similar endpoints.
70450-70468
: BridgeConfig and ChainType Enum Update (opinit.ophost):
The updated schema for BridgeConfig with the embedded ChainType enum is clear. The additional enum values and descriptions are well documented.
70488-70497
: Target Chain Type Enum Update (opinit.ophost):
The target chain type enum appears updated consistently for BridgeConfig.
70502-70508
: Finalization and Submission Update (opinit.ophost):
The updates for “finalization_period” and “submission_start_height” are consistent and clearly written.
70539-70545
: UpgradePolicy Description Clarification:
The text for UpgradePolicy is updated with detailed explanations for each enum value. The changes are clear and useful.
70693-70699
: UpgradePolicy Description Update (Part 2):
The changes further refine the descriptions for the UpgradePolicy enum. The text is clear and consistent.
71192-71198
: Final UpgradePolicy Update:
The detailed explanations for each UpgradePolicy value in this block are consistent with earlier updates.
72221-72246
: CurrencyPairMapping Schema Enhancement:
The updated schema for the CurrencyPairMapping now includes nested definitions with clear descriptions. This is a useful enhancement for clarity.
72263-72301
: Oracle Currency Pairs Response Updates:
The expanded documentation for both GetAllCurrencyPairsResponse and GetCurrencyPairMappingListResponse is comprehensive. All nested properties and descriptions are clear.
73011-73146
: MarketResponse and Params Schema Revision:
The revised schema for the MarketsResponse — including detailed nested definitions for ticker, provider_configs, and additional properties — is thorough. Verify that these schema updates are in full alignment with the backend data models.shared.Dockerfile (2)
1-1
: Update Go Builder Base ImageThe base image was updated from Go 1.22 to Go 1.23, which aligns with the updated dependency requirements across the project. Ensure that any build-time dependencies or behavior that rely on the Go version have been verified with the new image.
14-15
: Verify File Path EscapingThe paths in the
cp
commands use escaped hyphens (e.g.,initia\-labs
). Confirm that these escapes are necessary for the Docker environment and do not interfere with module path resolution.Dockerfile.arm64 (1)
2-2
: Update ARM64 Go Builder Base ImageThe ARM64 Dockerfile now uses
arm64v8/golang:1.23-bullseye
instead of the previous 1.22 version. This change is consistent with the PR objectives and ensures uniformity in Go versions across architectures.README.md (2)
5-6
: Remove Outdated URLThe outdated GitHub repository URL has been removed from the documentation. This cleanup is appropriate if the URL is no longer required; just ensure that any relevant links are maintained elsewhere if needed.
7-9
: Update Go Version PrerequisiteThe prerequisites now require at least Go v1.23.1+. This update correctly reflects the changes in the build configurations and Dockerfiles. Be sure to update any related documentation or installation instructions if other parts of the project still reference the older version.
.github/workflows/build-linux-amd64.yml (1)
15-15
: Update Go Version in WorkflowThe Go version has been updated from "1.22" to "1.23" in the workflow configuration. This ensures consistency throughout the CI environment based on the updated Dockerfiles and build requirements.
.github/workflows/test.yml (1)
29-30
: Update Go Version in Test WorkflowThe Go version for the test workflow has been changed from 1.22 to 1.23. This update aligns the testing environment with the new dependency specifications.
Dockerfile (1)
2-2
: Updated Go Base Image: The Dockerfile now usesgolang:1.23-alpine
for the go-builder stage. This change is consistent with the upgrade objective. Consider pinning the specific Alpine version (e.g., alpine3.19) if deterministic builds or security fixes are required..github/workflows/build-darwin-arm64.yml (1)
17-17
: Updated Go Version in Workflow: The workflow now setsgo-version: "1.23"
, which aligns with the updated base image in the Dockerfile. This consistency helps ensure that all build steps use the same Go version..github/workflows/build-darwin-amd64.yml (1)
18-18
: Consistent Go Version Update: Thego-version
is updated to"1.23"
, matching the changes in the Dockerfile and other workflows. This uniformity across the build configurations is beneficial.go.mod (13)
3-3
: Bump Go Version: The Go version is now updated to1.23.1
. Ensure that all modules and code are compatible with any subtle changes introduced in Go 1.23.
5-5
: Toolchain Update: The toolchain version has been bumped togo1.23.2
, which complements the new Go version and ensures consistency across builds.
19-19
: Dependency Update — cometbft: Thegithub.com/cometbft/cometbft
dependency is updated tov0.38.17
. Please verify that this version upgrade does not introduce any breaking changes in its API or behavior.
27-27
: Dependency Update — ibc-go: Updatinggithub.com/cosmos/ibc-go/v8
to versionv8.5.3
aligns with the overall dependency bump. It’s advisable to run integration tests to ensure compatibility.
30-30
: OPinit Package Update: The dependencygithub.com/initia-labs/OPinit
is upgraded tov0.7.0
, meeting the expectations outlined in the PR objectives.
31-31
: Initia Package Update: Thegithub.com/initia-labs/initia
dependency is also updated tov0.7.0
. This change helps keep the dependency tree current.
39-39
: Forwarding Dependency Update: Thegithub.com/noble-assets/forwarding/v2
package is bumped tov2.0.0
. Confirm via release notes that there are no breaking changes that may affect the project.
42-42
: Block SDK Upgrade: The dependencygithub.com/skip-mev/block-sdk/v2
is updated tov2.1.5
. Please ensure that any functionality relying on this package is adequately tested.
43-43
: Connect Package Update: Thegithub.com/skip-mev/connect/v2
package is now at versionv2.3.0
. As in other dependency bumps, verify that the updated API interfaces do not break existing integrations.
47-47
: Testify Update: Upgradinggithub.com/stretchr/testify
tov1.10.0
improves test assertion capabilities. Ensure that all tests pass with this change.
283-283
: Replace Directive Update for cometbft: The replace directive now points togithub.com/initia-labs/cometbft v0.0.0-20250204072819-a4b3fcdff78f
. Make sure this commit hash is the intended target and that downstream consumers work correctly with it.
284-284
: Replace Directive Update for ibc-go: The replace directive forgithub.com/cosmos/ibc-go/v8
now usesgithub.com/initia-labs/ibc-go/v8 v8.0.0-20250204081745-02cc37be3d29
. Confirm that this forked version integrates well with your application.
288-288
: GRPC Version Override: The replace directive downgradesgoogle.golang.org/grpc
tov1.65.0
to mitigate issues observed with simulations (as commented). Verify that this version does not conflict with other dependencies expectingv1.70.0
.
Description
Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
!
in the type prefix if API or client breaking changeReviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
I have...
Summary by CodeRabbit
New Features
Documentation
Chores
Refactor